/*
 * Package il.ac.biu.cs.grossmm.api.presence
 * File XomPidf.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package il.ac.biu.cs.grossmm.api.presence;

import static il.ac.biu.cs.grossmm.api.data.NodeTypeByInterface.*;
import il.ac.biu.cs.grossmm.api.data.NodeInterface;
import il.ac.biu.cs.grossmm.api.data.Nodeset;
import il.ac.biu.cs.grossmm.api.data.Property;
import nu.xom.Elements;

/**
 * Data node type for representation of presence documents based on extensible
 * PIDF format.
 * <p>
 * PIDF is a common presence data format for CPP-compliant presence protocols,
 * allowing presence information to be transferred across CPP-compliant protocol
 * boundaries without modification, with attendant benefits for security and
 * performance.
 */
public interface XomPidf extends NodeInterface {
	/**
	 * Set of all pidf tuples in this document. Tuples provide a way of
	 * segmenting presence information.
	 */
	Nodeset<XomPidf, XomPidfTuple> TUPLES =
		nodeset(XomPidf.class, XomPidfTuple.class);

	/**
	 * Set of all xml elements that appear directly under the
	 * <tt>&lt;presence&gt;</tt> element but are not <tt>&lt;tuple&gt;</tt>
	 * elements
	 */
	Property<XomPidf, Elements> OTHER = property(XomPidf.class, Elements.class);
}
